/*
 * Copyright 2013 floreysoft GmbH (www.floreysoft.net)
 *
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.floreysoft.gwt.drive.client.realtime;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * A collaborator on the document.
 * 
 */
public final class Collaborator extends JavaScriptObject {

	protected Collaborator() {
	}

	/**
	 * @return The color associated with the collaborator. 
	 */
	public native String color()/*-{
		return this.color;
	}-*/;

	/**
	 * @return The display name of the collaborator. 
	 */
	public native String displayName() /*-{
		return this.displayName;
	}-*/;

	/**
	 * @return True if the collaborator is anonymous, false otherwise. 
	 */
	public native boolean isAnonymous() /*-{
		return !!this.isAnonymous;
	}-*/;

	/**
	 * @return True if the collaborator is the local user, false otherwise.
	 */
	public native boolean isMe() /*-{
		return !!this.isMe;
	}-*/;

	/**
	 * @return A url that points to the profile photo of the user. 
	 */
	public native String photoUrl() /*-{
		return this.photoUrl;
	}-*/;

	/**
	 * @return The sessionId of the collaborator. 
	 */
	public native String sessionId() /*-{
		return this.sessionId;
	}-*/;

	/**
	 * @return The userId of the collaborator. 
	 */
	public native String userId() /*-{
		return this.userId;
	}-*/;
}
